Skip to content
This repository has been archived by the owner on Aug 4, 2023. It is now read-only.

Override get_should_continue for science museum ingester #868

Merged
merged 1 commit into from
Nov 12, 2022
Merged

Override get_should_continue for science museum ingester #868

merged 1 commit into from
Nov 12, 2022

Conversation

aqeelat
Copy link
Contributor

@aqeelat aqeelat commented Nov 11, 2022

Fixes

Fixes WordPress/openverse#1363 by @obulat

Description

Overriding get_should_continue to terminate the pagination when we reach the end of the results.

Testing Instructions

I wanted to use a test like:

def test_get_should_continue():
    # Arrange
    params = {**default_params, "page[size]": 1} # updating the default params to reduce the response size
    first_page_json = sm.get_response_json(params)
    last_page_number = first_page_json.get("meta", {}).get("total_pages", 1) - 1

    # Act
    params["page[number]"] = last_page_number - 1
    _, should_continue = sm.get_batch(params)
    params["page[number]"] = last_page_number
    _, should_not_continue = sm.get_batch(params)

    # Assert
    assert should_continue is True
    assert should_not_continue is False

But because I wasn't using a mocked ingester, the code was actually trying to call the api.
So, I looked at other places that test get_should_continue and apparently they're just testing the function itself.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin 
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@aqeelat aqeelat requested a review from a team as a code owner November 11, 2022 15:50
@aqeelat aqeelat requested review from krysal and obulat November 11, 2022 15:50
@openverse-bot openverse-bot added 💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Nov 11, 2022
@aqeelat aqeelat force-pushed the science_museum_get_should_continue branch from 7b7a54c to 43b2639 Compare November 11, 2022 15:51
krysal
krysal approved these changes Nov 11, 2022
View reviewed changes
Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks for your help, @aqeelat!

obulat
obulat approved these changes Nov 12, 2022
View reviewed changes
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution, @aqeelat! The tests are great 🚀

@obulat obulat merged commit 1bee01c into WordPress:main Nov 12, 2022
@aqeelat aqeelat deleted the science_museum_get_should_continue branch November 12, 2022 10:42
Pmeet pushed a commit to Pmeet/openverse-catalog that referenced this pull request Nov 15, 2022
@aqeelat
Override get_should_continue for science museum ingester (WordPress…
0683ab9 
…#868)

Override get_should_continue for science museum ingester
@AetherUnbound AetherUnbound mentioned this pull request Dec 1, 2022
Closed
1 task
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@obulat obulat obulat approved these changes

@krysal krysal krysal approved these changes

Assignees
No one assigned
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Science museum script needs to implement get_should_continue to stop ingestion
4 participants
@aqeelat @krysal @obulat @openverse-bot